<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxScopeAttr_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxScopeAttr_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a8b181652f06ae70ec916c58dc0f3d114" id="r_a8b181652f06ae70ec916c58dc0f3d114"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_scope_attr__t.html#a8b181652f06ae70ec916c58dc0f3d114">structSize</a></td></tr>
<tr class="separator:a8b181652f06ae70ec916c58dc0f3d114"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4db5037a7c7970861688d47db6c0f2a" id="r_af4db5037a7c7970861688d47db6c0f2a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_scope_attr__t.html#af4db5037a7c7970861688d47db6c0f2a">path</a></td></tr>
<tr class="separator:af4db5037a7c7970861688d47db6c0f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48eeeed47ef503c114af84c40d39ef98" id="r_a48eeeed47ef503c114af84c40d39ef98"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_scope_attr__t.html#a48eeeed47ef503c114af84c40d39ef98">parentScope</a></td></tr>
<tr class="separator:a48eeeed47ef503c114af84c40d39ef98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca9b5b78f0557ccf9c009ce797f9fe87" id="r_aca9b5b78f0557ccf9c009ce797f9fe87"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_scope_attr__t.html#aca9b5b78f0557ccf9c009ce797f9fe87">scopeId</a></td></tr>
<tr class="separator:aca9b5b78f0557ccf9c009ce797f9fe87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00911">911</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a48eeeed47ef503c114af84c40d39ef98" name="a48eeeed47ef503c114af84c40d39ef98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48eeeed47ef503c114af84c40d39ef98">&#9670;&#160;</a></span>parentScope</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxScopeAttr_t::parentScope</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Identifier of the parent scope, to which <code>path</code> is appended. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00934">934</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="af4db5037a7c7970861688d47db6c0f2a" name="af4db5037a7c7970861688d47db6c0f2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4db5037a7c7970861688d47db6c0f2a">&#9670;&#160;</a></span>path</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* nvtxScopeAttr_t::path</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Path delimited by '/' characters, relative to parentScope. Leading slashes are ignored. Nodes in the path may use name[key] syntax to indicate an array of sibling nodes, which may be combined with other non-array nodes or different arrays at the same scope. Node names should be UTF8 printable characters. '\' has to be used to escape '/', '[', and ']' characters in node names. An empty C string "" and <code>NULL</code> are valid inputs and treated equivalently.</p>
<p>A GPU can be specified using its</p><ul>
<li>unique identifier (UUID) with "GPU[UUID:#]",</li>
<li>CUDA device ID (sensitive to CUDA_VISIBLE_DEVICES) with "GPU[CUDAID:#]",</li>
<li>NVML (nvidia-smi) device ID with "GPU[NVSMI:#]" (replace <code>#</code> with the actual device ID). For display purposes, a tool is recommended to show a pretty name. </li>
</ul>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00931">931</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="aca9b5b78f0557ccf9c009ce797f9fe87" name="aca9b5b78f0557ccf9c009ce797f9fe87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca9b5b78f0557ccf9c009ce797f9fe87">&#9670;&#160;</a></span>scopeId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxScopeAttr_t::scopeId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Static scope ID. Must be unique within the domain, &gt;= NVTX_SCOPE_ID_STATIC_START, and &lt; NVTX_SCOPE_ID_DYNAMIC_START. Use NVTX_SCOPE_NONE to let the tool create a (dynamic) scope ID. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00941">941</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a8b181652f06ae70ec916c58dc0f3d114" name="a8b181652f06ae70ec916c58dc0f3d114"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b181652f06ae70ec916c58dc0f3d114">&#9670;&#160;</a></span>structSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxScopeAttr_t::structSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00913">913</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
